﻿//AcademicPlanner - course registration planning web app.
//Copyright (C) 2009  Boubacar Diallo

//This program is free software; you can redistribute it and/or
//modify it under the terms of the GNU General Public License
//as published by the Free Software Foundation; either version 2
//of the License, or (at your option) any later version.

//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.

//You should have received a copy of the GNU General Public License
//along with this program; if not, write to the Free Software
//Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace AcademicPlanner.Data.Entities
{
	/// <summary>
	/// CourseDivisionEntity represents the data aspect of a domain layer's <c>CourseDivision</c>.
	/// </summary>
	/// <since>1.0</since>
    public class CourseDivisionEntity : Entity
    {
		/// <summary>
		/// Gets or sets the name of this CourseDivisionEntity.
		/// </summary>
		/// <since>1.0</since>
		public virtual string Name { get; set; }

		/// <summary>
		/// Gets or sets the list of <c>CourseCategoryEntity</c>s under this CourseDivisionEntity.
		/// </summary>
		/// <since>1.0</since>
		public virtual IList<CourseCategoryEntity> CategoryEntities { get; set; }

		/// <summary>
		/// Gets the <c>PlanEntity</c> this CourseDivisionEntity belongs to.
		/// </summary>
		/// <since>1.0</since>
		public virtual AcademicPlanEntity PlanEntity { get; set; }


		/// <summary>
		/// Sets default values for this CourseDivisionEntity's properites.
		/// </summary>
		/// <remarks>
		/// <c>Name</c> is set to <c>""</c>.
		/// <c>CourseCategoryEntities</c> is set to an empty list.
		/// </remarks>
		/// <since>1.0</since>
		public override void SetDefaults()
		{
			base.SetDefaults();
			Name = "";
			CategoryEntities = new List<CourseCategoryEntity>();
		}

		/// <summary>
		/// Adds a <c>CourseCategoryEntity</c> to this CourseDivisionEntity's 
		/// <c>CategoryEntities</c>.
		/// </summary>
		/// <param name="pEntity">The <c>CourseCategoryEntity</c> to add.</param>
		/// <since>1.0</since>
		public virtual void AddCategoryEntity(CourseCategoryEntity pEntity)
		{
			pEntity.DivisionEntity = this;
			CategoryEntities.Add(pEntity);
		}
    }
}
